Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update user guide #5

Merged
merged 21 commits into from
Feb 22, 2024
Merged

update user guide #5

merged 21 commits into from
Feb 22, 2024

Conversation

imrn99
Copy link
Collaborator

@imrn99 imrn99 commented Feb 19, 2024 •
edited
Loading

Description

Complete the user guide with:

Preview the changes locally:

# Serve the doc on a local server
mdbook serve --open -d ../target/doc/ honeycomb-guide/ &
cargo doc --all --no-deps
# Kill the local server
kill $(pidof mdbook) 

# Without pidof
kill $(ps -e | awk '/mdbook/ {print $1}')

Scope

  • Documentation
  • Repository

Type of change

  • New feature(s)

Other

...

Necessary follow-up

...

Mentions

...

@imrn99
fix: replace BetaFunc images with a corrected one
4024374 
the orientation of the cells was inconsistent
cedricchevalier19
cedricchevalier19 approved these changes Feb 21, 2024
View reviewed changes
Copy link
Member

@cedricchevalier19 cedricchevalier19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot say for the maths but it looks really great!

README.md Show resolved Hide resolved
README.md Outdated
Comment on lines 29 to 31
You may also use the `build` subcommand of mdbook and browse the files directly,
but there may be navigation problems because of some implicit links (e.g. folders
instead of index files) depending on your browser.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure either, but you can leave it there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it since there already is a linking warning in the notes from the honeycomb-guide section of the UG

README.md Outdated Show resolved Hide resolved
honeycomb-guide/src/definitions/betaf.md Outdated Show resolved Hide resolved
honeycomb-guide/src/index.md Outdated Show resolved Hide resolved
honeycomb-guide/src/index.md Outdated Show resolved Hide resolved
honeycomb-guide/src/project-structure/honeycomb-core.md Show resolved Hide resolved
honeycomb-guide/src/project-structure/honeycomb-guide.md Outdated Show resolved Hide resolved
@imrn99 imrn99 merged commit e04d601 into master Feb 22, 2024
3 checks passed
@imrn99 imrn99 deleted the update-user-guide branch February 22, 2024 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cedricchevalier19 cedricchevalier19 cedricchevalier19 approved these changes

@franck-ledoux franck-ledoux Awaiting requested review from franck-ledoux

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@imrn99 @cedricchevalier19